Skip to content

Jobs · Cancel a job

Cancels a job that is still queued. A running, finished, expired or already cancelled job is unchanged. Cancelling costs 0 credits.

0 credits per request0 credits on error & cache
POST
/v1/jobs/{id}/cancel

Credit Cost & Caching

View credit packs ↗

Default: 0 credits

An empty result costs 0 credits.

How charges are determined

Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns.

A call that fails costs 0 credits. A result served from cache costs 0 credits.

`default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins.

A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true).

A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.

Cache control

Not specified in the published contract.

Pagination

Check cursor / page parameters and response fields below.

Authorizations · Headers

x-api-keystringheaderrequired

Your Fetchproof API key (starts with fp_live_). Create one at app.fetchproof.com.

Path & Query Parameters

1 parameter
idstringpathrequired

Job id from the 202 response. Pass that id and nothing else.

Example:00000000-0000-4000-8000-000000000000

Response Schemas

200Job state. Reading or cancelling a job costs 0 credits.
Content-Typeapplication/json
object
jobIdstringrequired
statusstringrequired
Options:queuedrunningsucceededfailedexpiredcancelled
resultanyoptional

The finished operation body, present once the job has ended.

401Invalid or missing x-api-key
404No such job for this team, or the 24 hour result window has passed.
POST

/v1/jobs/{id}/cancel

Parameters

string path required

Job id from the 202 response. Pass that id and nothing else.

Request URL

https://api.fetchproof.com/v1/jobs/{id}/cancel

Snippets use a $FETCHPROOF_API_KEY placeholder. To run a live call, use the dashboard Playground.

 
↑↓ navigate · ↵ open · esc close